//  ================================================================
//  Copyright (c) 2000-2005 CollabNet.  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//  
//  1. Redistributions of source code must retain the above copyright
//  notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//  notice, this list of conditions and the following disclaimer in the
//  documentation and/or other materials provided with the distribution.
//  
//  3. The end-user documentation included with the redistribution, if
//  any, must include the following acknowlegement: "This product includes
//  software developed by Collab.Net <http://www.Collab.Net/>."
//  Alternately, this acknowlegement may appear in the software itself, if
//  and wherever such third-party acknowlegements normally appear.
//  
//  4. The hosted project names must not be used to endorse or promote
//  products derived from this software without prior written
//  permission. For written permission, please contact info@collab.net.
//  
//  5. Products derived from this software may not use the "Tigris" or 
//  "Scarab" names nor may "Tigris" or "Scarab" appear in their names without 
//  prior written permission of Collab.Net.
//  
//  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
//  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
//  IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
//  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
//  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
//  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
//  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
//  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
//  ====================================================================
//  
//  This software consists of voluntary contributions made by many
//  individuals on behalf of Collab.Net.
package org.tigris.scarab.om;

import java.util.List;

// Turbine classes
import org.apache.torque.TorqueException;
import org.apache.torque.om.ObjectKey;
import org.apache.torque.util.Criteria;

// Scarab classes
import org.tigris.scarab.services.cache.ScarabCache;
import org.tigris.scarab.tools.localization.L10NKeySet;
import org.tigris.scarab.util.ScarabException;


/** 
 *  You should add additional methods to this class to meet the
 *  application requirements.  This class will only be generated as
 *  long as it does not already exist in the output directory.
 */
public class ReportPeer 
    extends BaseReportPeer
{
    private static final String REPORT_PEER = 
        "ReportPeer";
    private static final String RETRIEVE_BY_PK = 
        "retrieveByPK";

    /**
     * Does a saved report exist under the given name.
     *
     * @param name a <code>String</code> report name
     * @return true if a report by the given name exists
     */
    public static boolean exists(final String name)
        throws TorqueException, ScarabException
    {
        return retrieveByName(name) != null;
    }

    /**
     * gets the active report saved under the given name
     *
     * @param name a <code>String</code> value
     * @return a <code>Report</code> value
     * @exception Exception if an error occurs
     */
    public static Report retrieveByName(final String name)
        throws TorqueException, ScarabException
    {
        Report report = null;
        final Criteria crit = new Criteria()
            .add(NAME, name)
            .add(DELETED, false);
        final List reports = doSelect(crit);
        if (reports.size() == 1) 
        {
            report = (Report)reports.get(0);
        }
        else if (reports.size() > 1) 
        {
            throw new ScarabException(L10NKeySet.ExceptionMultipleReports,
                                      name);
        }
        
        return report;
    }

    /** 
     * Retrieve a single object by pk
     *
     * @param pk
     */
    public static Report retrieveByPK(ObjectKey pk)
        throws TorqueException
    {
        Report result = null;
        Object obj = ScarabCache.get(REPORT_PEER, RETRIEVE_BY_PK, pk); 
        if (obj == null) 
        {        
            result = BaseReportPeer.retrieveByPK(pk);
            ScarabCache.put(result, REPORT_PEER, RETRIEVE_BY_PK, pk);
        }
        else 
        {
            result = (Report)obj;
        }
        return result;
    }
}
